feat: Added OAuth Support for Public APIs with TokenManager Integration #813

sbansla · 2024-09-18T06:15:23Z

Feature

Added OAuth functionality for public APIs.

We are introducing an OAuth feature where clients can initialize credentials using ClientCredentialProvider and then call an API. The API will be called using a token generated from the client credentials passed via ClientCredentialProvider.
Token retrieval will occur without client intervention.
Created a TokenManager service to fetch tokens using the TokenCreator API from the preview-iam domain.
Updated documentation and examples in the README."

Checklist

I acknowledge that all my contributions will be made under the project's license
I have made a material change to the repo (functionality, testing, spelling, grammar)
I have read the Contribution Guidelines and my PR follows them
I have titled the PR appropriately
I have updated my branch with the main branch
I have added tests that prove my fix is effective or that my feature works
I have added the necessary documentation about the functionality in the appropriate .md file
I have added inline documentation to the code I modified

If you have questions, please file a support ticket, or create a GitHub Issue in this repository.

AsabuHere · 2024-10-03T10:30:03Z

README.md

@@ -214,6 +214,12 @@ public class Example {
 }
 ```

+### OAuth Feature
+We are introducing Client Credentials Flow-based OAuth 2.0 authentication. 


Can we mention the orgs auth is also in beta? since we changed back from preview?

AsabuHere · 2024-10-03T10:33:39Z

src/main/java/com/twilio/annotations/Preview.java

@@ -1,12 +0,0 @@
-package com.twilio.annotations;


why did we remove this

The previous idea was to move our API from preview to beta and public as backend API moves, but we can not track that, so to keep simple we will have only Beta

AsabuHere · 2024-10-03T10:35:08Z

src/main/java/com/twilio/auth_strategy/TokenAuthStrategy.java

+
+    @Override
+    public String getAuthString() {
+        return "Bearer " + token;


Can we add a null check here

Call fetch token

AsabuHere · 2024-10-03T10:40:56Z

src/main/java/com/twilio/http/Request.java

-        final String credentials = this.username + ":" + this.password;
-        final String encoded = Base64.getEncoder().encodeToString(credentials.getBytes(StandardCharsets.US_ASCII));
-        return "Basic " + encoded;
+        if (username != null && password != null) {


Can we convert username and password into basic auth strategy in any of the previous steps and just follow auth strategy based methods here?

That is a good suggestion, I think we might have to check if it will break existing customer who are using below configuration:
https://github.com/twilio/twilio-java/blob/main/advanced-examples/custom-http-client.md

AsabuHere · 2024-10-03T10:43:49Z

src/main/java/com/twilio/http/TwilioRestClient.java

@@ -59,7 +68,14 @@ protected TwilioRestClient(Builder b) {
     * @return Response object
     */
    public Response request(final Request request) {
-        request.setAuth(username, password);
+        if (username != null && password != null) {
+            request.setAuth(username, password);


Maybe we can move get auth string to individual auth strategy class and just fetch and set the value in request class

In case if we moved username and password to authstrategy class, we can do that.

AsabuHere · 2024-10-03T10:46:18Z

src/main/java/com/twilio/http/TwilioRestClient.java

+        if(response != null) {
+            int statusCode = response.getStatusCode();
+            if (statusCode == HTTP_STATUS_CODE_UNAUTHORIZED && authStrategy != null && EnumConstants.AuthType.TOKEN.equals(authStrategy.getAuthType())) {
+                ((TokenAuthStrategy)authStrategy).fetchToken();


Moving fetchtoken logic inside auth strategy class and just fetching the auth string would be more aligned to the concept of abstraction

Discussed over call, this code is required for fetching token in case there is 401
Will be adding fetchToken in getAuthString() method as mentioned in previous comment.

AsabuHere

LGTM

sonarcloud · 2024-10-03T13:19:12Z

Quality Gate failed

Failed conditions
44.0% Coverage on New Code (required ≥ 80%)
B Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

chore: added oauth functionality

dd7006f

sbansla changed the title ~~Public oauth rest client~~ chore: Public oauth rest client Sep 18, 2024

fixed authstrategy code

aa293e0

sbansla changed the base branch from OAuth-Public-APIs to main September 19, 2024 15:56

sbansla changed the title ~~chore: Public oauth rest client~~ chore: Public oauth rest client [DO-NOT-MERGE] Sep 19, 2024

sbansla and others added 6 commits September 20, 2024 10:46

added null check for authstrategy

81d1758

updated readme with OAuth feature for public APIs

2bc465f

chore: reseting account during oauth init

f8af734

chore: add logging when token is fetched

5176a49

Merge branch 'main' into public-oauth-rest-client

8ee69fe

chore: added oauth api call example

0850ea7

sbansla changed the title ~~chore: Public oauth rest client [DO-NOT-MERGE]~~ feat: Public oauth rest client [DO-NOT-MERGE] Sep 27, 2024

sbansla changed the title ~~feat: Public oauth rest client [DO-NOT-MERGE]~~ feat: Public OAuth [DO-NOT-MERGE] Sep 27, 2024

sbansla changed the title ~~feat: Public OAuth [DO-NOT-MERGE]~~ feat: Added OAuth Support for Public APIs with TokenManager Integration [DO-NOT-MERGE] Sep 27, 2024

chore: added cluster test

cba6839

sbansla requested a review from AsabuHere September 30, 2024 11:04

sbansla added 2 commits September 30, 2024 16:47

chore: corrected the exception msg

6ab9442

chore: added secret

58a022a

sbansla marked this pull request as ready for review September 30, 2024 12:30

sbansla changed the title ~~feat: Added OAuth Support for Public APIs with TokenManager Integration [DO-NOT-MERGE]~~ feat: Added OAuth Support for Public APIs with TokenManager Integration Oct 3, 2024

AsabuHere reviewed Oct 3, 2024

View reviewed changes

chore: updated fetching token in getAuthString method

0f10880

sbansla requested review from AsabuHere and tiwarishubham635 October 3, 2024 12:23

overriden equal method for authstrategy

be5dcce

tiwarishubham635 approved these changes Oct 3, 2024

View reviewed changes

update readme

db56638

AsabuHere approved these changes Oct 3, 2024

View reviewed changes

updated readme

3bd1e60

sbansla merged commit 30e91a6 into main Oct 3, 2024
11 of 12 checks passed

sbansla deleted the public-oauth-rest-client branch October 3, 2024 13:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Added OAuth Support for Public APIs with TokenManager Integration #813

feat: Added OAuth Support for Public APIs with TokenManager Integration #813

sbansla commented Sep 18, 2024 •

edited

Loading

AsabuHere Oct 3, 2024

AsabuHere Oct 3, 2024

sbansla Oct 3, 2024

AsabuHere Oct 3, 2024

AsabuHere Oct 3, 2024

AsabuHere Oct 3, 2024

sbansla Oct 3, 2024

AsabuHere Oct 3, 2024

sbansla Oct 3, 2024

AsabuHere Oct 3, 2024

sbansla Oct 3, 2024

AsabuHere left a comment

sonarcloud bot commented Oct 3, 2024

feat: Added OAuth Support for Public APIs with TokenManager Integration #813

feat: Added OAuth Support for Public APIs with TokenManager Integration #813

Conversation

sbansla commented Sep 18, 2024 • edited Loading

Feature

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AsabuHere left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Oct 3, 2024

Quality Gate failed

sbansla commented Sep 18, 2024 •

edited

Loading